/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ------------------------------------------------------------------------
 */
package org.knime.core.node.workflow;

import static org.hamcrest.Matchers.hasItems;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;

import java.util.Arrays;
import java.util.Collection;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;

import org.junit.Before;
import org.junit.Test;

/**
 * Tests the
 * {@link WorkflowManager#getNodeContainers(java.util.Set, java.util.function.Predicate, boolean, boolean)}-method.
 *
 * @author Martin Horn, KNIME GmbH, Konstanz, Germany
 */
public class EnhWEBP269_DepthFirstNodeAndSuccessors extends WorkflowTestCase {

    @Before
    public void setup() throws Exception {
        loadAndSetWorkflow();
    }

    /**
     * Test without stop condition but all combination of the two boolean parameters of
     * {@link WorkflowManager#getNodeContainers(Set, Predicate, boolean, boolean)}.
     *
     * @throws Exception
     */
    @Test
    public void testGetNodeContainers() throws Exception {
        WorkflowManager wfm = getManager();

        Collection<NodeContainer> ncs = wfm.getNodeContainers(nodeSet(wfm, 1, 2), null, false, false);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 44, 41, 11, 23, 40)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 42, 36, 46))));

        ncs = wfm.getNodeContainers(nodeSet(wfm, 1, 2, 46), null, true, false);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 41, 11, 23, 40)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 42, 36))));

        ncs = wfm.getNodeContainers(nodeSet(wfm, 1, 2), null, false, true);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 41, 11, 23, 40, 44)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 36))));

        ncs = wfm.getNodeContainers(nodeSet(wfm, 1, 2, 46), null, true, true);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 41, 11, 23, 40, 42)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 36, 44))));
    }

    /**
     * Test {@link WorkflowManager#getNodeContainers(Set, Predicate, boolean, boolean)} with a stop condition provided.
     */
    @Test
    public void testGetNodeContainersWithStopCondition() {
        WorkflowManager wfm = getManager();

        Predicate<NodeContainer> stopCondition = nc -> nc.getID().equals(wfm.getID().createChild(45));

        Collection<NodeContainer> ncs = wfm.getNodeContainers(nodeSet(wfm, 3, 36), stopCondition, false, false);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 44, 43)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 40, 10))));

        ncs = wfm.getNodeContainers(nodeSet(wfm, 3, 5, 36), stopCondition, true, false);
        assertThat("expected nodes not found in the list", ncs, hasItems(nodeArray(wfm, 36)));
        assertThat("unexpected nodes found in the list", ncs, not(hasItems(nodeArray(wfm, 44, 42, 10))));
    }

    private static Set<NodeID> nodeSet(final WorkflowManager wfm, final int... ids) {
        return Arrays.stream(ids).mapToObj(id -> wfm.getID().createChild(id)).collect(Collectors.toSet());
    }

    private static NodeContainer[] nodeArray(final WorkflowManager wfm, final int... ids) {
        return Arrays.stream(ids).mapToObj(id -> wfm.getNodeContainer(wfm.getID().createChild(id)))
            .toArray(s -> new NodeContainer[s]);
    }

}
